org.springframework.test.web.reactive.server

Class DefaultWebTestClient.DefaultRequestBodyUriSpec

java.lang.Object

org.springframework.test.web.reactive.server.DefaultWebTestClient.DefaultRequestBodyUriSpec

All Implemented Interfaces:

WebTestClient.RequestBodySpec, WebTestClient.RequestBodyUriSpec, WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>, WebTestClient.RequestHeadersUriSpec<WebTestClient.RequestBodySpec>, WebTestClient.UriSpec<WebTestClient.RequestBodySpec>

Enclosing class:

DefaultWebTestClient

private class DefaultWebTestClient.DefaultRequestBodyUriSpec
extends java.lang.Object
implements WebTestClient.RequestBodyUriSpec

Field Summary

Fields

Modifier and Type	Field and Description
private WebClient.RequestBodyUriSpec	bodySpec
private java.lang.String	requestId
private java.lang.String	uriTemplate

Constructor Summary

Constructors

Constructor and Description
DefaultRequestBodyUriSpec(WebClient.RequestBodyUriSpec spec)

Method Summary

Modifier and Type	Method and Description
WebTestClient.RequestBodySpec	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
WebTestClient.RequestBodySpec	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
WebTestClient.RequestBodySpec	attribute(java.lang.String name, java.lang.Object value) Set the attribute with the given name to the given value.
WebTestClient.RequestBodySpec	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer) Manipulate the request attributes with the given consumer.
WebTestClient.RequestHeadersSpec<?>	body(BodyInserter<?,? super ClientHttpRequest> inserter) Set the body of the request to the given BodyInserter.
<T,S extends <any>> WebTestClient.RequestHeadersSpec<?>	body(S publisher, java.lang.Class<T> elementClass) Set the body of the request to the given asynchronous Publisher.
WebTestClient.RequestBodySpec	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
WebTestClient.RequestBodySpec	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
WebTestClient.RequestBodySpec	cookie(java.lang.String name, java.lang.String value) Add a cookie with the given name and value.
WebTestClient.RequestBodySpec	cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer) Manipulate this request's cookies with the given consumer.
WebTestClient.ResponseSpec	exchange() Perform the exchange without a request body.
WebTestClient.RequestBodySpec	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
WebTestClient.RequestBodySpec	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate the request's headers with the given consumer.
WebTestClient.RequestBodySpec	ifModifiedSince(java.time.ZonedDateTime ifModifiedSince) Set the value of the If-Modified-Since header.
WebTestClient.RequestBodySpec	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.
WebTestClient.RequestHeadersSpec<?>	syncBody(java.lang.Object body) Set the body of the request to the given synchronous Object and perform the request.
WebTestClient.RequestBodySpec	uri(java.util.function.Function<UriBuilder,java.net.URI> uriFunction) Build the URI for the request with a UriBuilder obtained through the UriBuilderFactory configured for this client.
WebTestClient.RequestBodySpec	uri(java.lang.String uriTemplate, java.util.Map<java.lang.String,?> uriVariables) Specify the URI for the request using a URI template and URI variables.
WebTestClient.RequestBodySpec	uri(java.lang.String uriTemplate, java.lang.Object... uriVariables) Specify the URI for the request using a URI template and URI variables.
WebTestClient.RequestBodySpec	uri(java.net.URI uri) Specify the URI using an absolute, fully constructed URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bodySpec

private final WebClient.RequestBodyUriSpec bodySpec

uriTemplate

@Nullable
private java.lang.String uriTemplate

requestId

private final java.lang.String requestId

Constructor Detail

DefaultRequestBodyUriSpec

DefaultRequestBodyUriSpec(WebClient.RequestBodyUriSpec spec)

Method Detail

uri

public WebTestClient.RequestBodySpec uri(java.lang.String uriTemplate,
                                         java.lang.Object... uriVariables)

Description copied from interface: WebTestClient.UriSpec

Specify the URI for the request using a URI template and URI variables. If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

Specified by:

uri in interface WebTestClient.UriSpec<WebTestClient.RequestBodySpec>

Returns:

spec to add headers or perform the exchange

uri

public WebTestClient.RequestBodySpec uri(java.lang.String uriTemplate,
                                         java.util.Map<java.lang.String,?> uriVariables)

Description copied from interface: WebTestClient.UriSpec

Specify the URI for the request using a URI template and URI variables. If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

Specified by:

uri in interface WebTestClient.UriSpec<WebTestClient.RequestBodySpec>

Returns:

spec to add headers or perform the exchange

uri

public WebTestClient.RequestBodySpec uri(java.util.function.Function<UriBuilder,java.net.URI> uriFunction)

Description copied from interface: WebTestClient.UriSpec

Build the URI for the request with a UriBuilder obtained through the UriBuilderFactory configured for this client.

Specified by:

uri in interface WebTestClient.UriSpec<WebTestClient.RequestBodySpec>

Returns:

spec to add headers or perform the exchange

uri

public WebTestClient.RequestBodySpec uri(java.net.URI uri)

Description copied from interface: WebTestClient.UriSpec

Specify the URI using an absolute, fully constructed URI.

Specified by:

uri in interface WebTestClient.UriSpec<WebTestClient.RequestBodySpec>

Returns:

spec to add headers or perform the exchange

header

public WebTestClient.RequestBodySpec header(java.lang.String headerName,
                                            java.lang.String... headerValues)

Description copied from interface: WebTestClient.RequestHeadersSpec

Add the given, single header value under the given name.

Specified by:

header in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

the same instance

headers

public WebTestClient.RequestBodySpec headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Description copied from interface: WebTestClient.RequestHeadersSpec

Manipulate the request's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

Specified by:

headers in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

attribute

public WebTestClient.RequestBodySpec attribute(java.lang.String name,
                                               java.lang.Object value)

Description copied from interface: WebTestClient.RequestHeadersSpec

Set the attribute with the given name to the given value.

Specified by:

attribute in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

name - the name of the attribute to add

value - the value of the attribute to add

Returns:

this builder

attributes

public WebTestClient.RequestBodySpec attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)

Description copied from interface: WebTestClient.RequestHeadersSpec

Manipulate the request attributes with the given consumer. The attributes provided to the consumer are "live", so that the consumer can be used to inspect attributes, remove attributes, or use any of the other map-provided methods.

Specified by:

attributes in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

attributesConsumer - a function that consumes the attributes

Returns:

this builder

accept

public WebTestClient.RequestBodySpec accept(MediaType... acceptableMediaTypes)

Description copied from interface: WebTestClient.RequestHeadersSpec

Set the list of acceptable media types, as specified by the Accept header.

Specified by:

accept in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

acceptableMediaTypes - the acceptable media types

Returns:

the same instance

acceptCharset

public WebTestClient.RequestBodySpec acceptCharset(java.nio.charset.Charset... acceptableCharsets)

Description copied from interface: WebTestClient.RequestHeadersSpec

Set the list of acceptable charsets, as specified by the Accept-Charset header.

Specified by:

acceptCharset in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

acceptableCharsets - the acceptable charsets

Returns:

the same instance

contentType

public WebTestClient.RequestBodySpec contentType(MediaType contentType)

Description copied from interface: WebTestClient.RequestBodySpec

Set the media type of the body, as specified by the Content-Type header.

Specified by:

contentType in interface WebTestClient.RequestBodySpec

Parameters:

contentType - the content type

Returns:

the same instance

See Also:

HttpHeaders.setContentType(MediaType)

contentLength

public WebTestClient.RequestBodySpec contentLength(long contentLength)

Description copied from interface: WebTestClient.RequestBodySpec

Set the length of the body in bytes, as specified by the Content-Length header.

Specified by:

contentLength in interface WebTestClient.RequestBodySpec

Parameters:

contentLength - the content length

Returns:

the same instance

See Also:

HttpHeaders.setContentLength(long)

cookie

public WebTestClient.RequestBodySpec cookie(java.lang.String name,
                                            java.lang.String value)

Description copied from interface: WebTestClient.RequestHeadersSpec

Add a cookie with the given name and value.

Specified by:

cookie in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

name - the cookie name

value - the cookie value

Returns:

the same instance

cookies

public WebTestClient.RequestBodySpec cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,java.lang.String>> cookiesConsumer)

Description copied from interface: WebTestClient.RequestHeadersSpec

Manipulate this request's cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other MultiValueMap methods.

Specified by:

cookies in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

cookiesConsumer - a function that consumes the cookies map

Returns:

this builder

ifModifiedSince

public WebTestClient.RequestBodySpec ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)

Description copied from interface: WebTestClient.RequestHeadersSpec

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

Specified by:

ifModifiedSince in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

ifModifiedSince - the new value of the header

Returns:

the same instance

ifNoneMatch

public WebTestClient.RequestBodySpec ifNoneMatch(java.lang.String... ifNoneMatches)

Description copied from interface: WebTestClient.RequestHeadersSpec

Set the values of the If-None-Match header.

Specified by:

ifNoneMatch in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Parameters:

ifNoneMatches - the new value of the header

Returns:

the same instance

body

public WebTestClient.RequestHeadersSpec<?> body(BodyInserter<?,? super ClientHttpRequest> inserter)

Description copied from interface: WebTestClient.RequestBodySpec

Set the body of the request to the given BodyInserter.

Specified by:

body in interface WebTestClient.RequestBodySpec

Parameters:

inserter - the inserter

Returns:

spec for decoding the response

See Also:

BodyInserters

body

public <T,S extends <any>> WebTestClient.RequestHeadersSpec<?> body(S publisher,
                                                                    java.lang.Class<T> elementClass)

Description copied from interface: WebTestClient.RequestBodySpec

Set the body of the request to the given asynchronous Publisher.

Specified by:

body in interface WebTestClient.RequestBodySpec

Type Parameters:

T - the type of the elements contained in the publisher

S - the type of the Publisher

Parameters:

publisher - the request body data

elementClass - the class of elements contained in the publisher

Returns:

spec for decoding the response

syncBody

public WebTestClient.RequestHeadersSpec<?> syncBody(java.lang.Object body)

Description copied from interface: WebTestClient.RequestBodySpec

Set the body of the request to the given synchronous Object and perform the request.

This method is a convenient shortcut for:

 .body(BodyInserters.fromObject(object))
 

The body can be a MultiValueMap to create a multipart request. The values in the MultiValueMap can be any Object representing the body of the part, or an HttpEntity representing a part with body and headers. The MultiValueMap can be built conveniently using

Specified by:

syncBody in interface WebTestClient.RequestBodySpec

Parameters:

body - the Object to write to the request

Returns:

a Mono with the response

exchange

public WebTestClient.ResponseSpec exchange()

Description copied from interface: WebTestClient.RequestHeadersSpec

Perform the exchange without a request body.

Specified by:

exchange in interface WebTestClient.RequestHeadersSpec<WebTestClient.RequestBodySpec>

Returns:

spec for decoding the response